Skip to content

Commit

Permalink
Removed obsolete
Browse files Browse the repository at this point in the history
  • Loading branch information
Serg-Norseman committed May 11, 2023
1 parent 6809f1f commit cdfacc4
Show file tree
Hide file tree
Showing 6 changed files with 1,968 additions and 2,073 deletions.
115 changes: 0 additions & 115 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,118 +73,3 @@ No code is perfect and we always welcome third-party patches. This document desc

* Improving the architecture and efficiency of the core
* Testing and bug fixes


# How to build GEDKeeper

## Dependencies

### Building

* Microsoft [.NET Framework](https://dotnet.microsoft.com/) 4.7.1
* Microsoft [Visual Studio 2017](https://visualstudio.microsoft.com/) or later

### Testing
* [NUnit](/~https://github.com/nunit) 2.6.4 or 3 (unit testing framework for .NET)

### Packaging

* [7-zip](https://sourceforge.net/projects/sevenzip/) compression
* Nullsoft Scriptable Install System ([NSIS](https://sourceforge.net/projects/nsis/)) 3.04

## For Windows

Run the script `build_all.mswin.x86.cmd` from the Windows command line.

Optionally pass the `release` option to the script to build without
debugging information. By default the script builds the executable with
embedded debugging information. The script skips testing for non-debug
builds.

## For Mono

Run the script `build_all.linux.x64.sh` from the Linux shell.


# The GEDKeeper testing

GEDKeeper uses [NUnit 2.6.4 or 3](http://www.nunit.org/), patches should come with
tests and all tests should pass before a commit or branch is merged.


### Quick start Windows command line

- Download the [NUnit binaries](http://github.com/nunit/nunitv2/releases/download/2.6.4/NUnit-2.6.4.zip), unzip and add to your path
- Build GEDKeeper project (usually in Visual Studio or SharpDevelop)
- `nunit-console-x86.exe projects\GKTests\bin\Debug\GKTests.dll`


### Quick start Mono command line

- Download the [NUnit binaries](http://github.com/nunit/nunitv2/releases/download/2.6.4/NUnit-2.6.4.zip), unzip and place somewhere accessible
- Build GEDKeeper project (usually in Xamarin Studio or MonoDevelop)
- `mono somewhere/nunit-console ./projects/GKTests/bin/Debug/GKTests.dll`

### Running Unit Tests in the IDE

NUnit is not incredibly robust in the IDEs at present, so results are mixed
but here are some suggestions.

In **Visual Studio**, NUnit has an integrated Visual Studio add-in which can be
downloaded from their website and used to run tests in the Test Explorer pane.

In **SharpDevelop**, in the Unit Tests window, you can right click on any test,
and then `Run tests`, which will allow everything to work.


# Frequently asked questions (FAQ)

**What are the prerequisites I need on my machine to build code in this project?**

On Linux
- Xamarin Studio or MonoDevelop with [Mono](http://www.mono-project.com/) installed.
- NUnit

On Windows

- Microsoft Windows® (Windows Vista or later) x86 or x64 versions
- Visual Studio 2010 (or later) ([Community edition](https://www.visualstudio.com/en/vs/community/))
or SharpDevelop 5.1 (or later) ([free IDE for C#](http://www.icsharpcode.net/OpenSource/SD/Download/))
- .NET Framework 4.7.1
- NUnit


**What platforms are supported?**

GEDKeeper is cross-platform and can be run on Linux and Windows.
In particular, it supports the following platforms:

- Windows Vista (or later) and .NET 4.7.1 (or later)
- Linux (Debian/Ubuntu) and Mono 4.7.1 (or later)

We currently do not support iOS or Android, although it is possible it could
be added in the future.


**I am a new developer to the project and I want to build the project**

- First download the source code you want to start with (under the Source Code tab)
- Start selected IDE, then select File->Open -> Project/Solution
- Select `GEDKeeper2.sln` in the open project dialog box
- Mouse or tab to the solution Explorer Window, right click on the solution and then choose "build solution"


**I found a bug - how do I report it?**

- Click the [Issues](/~https://github.com/serg-norseman/gedkeeper/issues) link.
- Click the "New Issue" button.
- Choose a descriptive title.
- List the component you found the issue in.
- List all the steps to reproduce the problem and include files or images if necessary.
- Describe the impact to you - like blocks all my development or minor usability issue.


**I have a suggestion for a new feature or some new ideas for the project.
How do I make a suggestion?**

- Use the [Issues](/~https://github.com/serg-norseman/gedkeeper/issues) link.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ If your problem or idea is not addressed yet, please open a new issue.

## Implementations

- "GEDKeeper2", standard (NET4.7.1 & WinForms based)
- "GEDKeeper3", cross-platform (NET Standard & Eto based)
- "GEDKeeperX", future mobile (NET Standard & Xamarin based), initial experience
- "GEDKeeper2", standard (NET4.7.1 & WinForms)
- "GEDKeeper3", cross-platform (NET6 & Eto.Forms)
- "GEDKeeperX", future mobile (NET Standard & Xamarin), initial experience


## Supported languages
Expand Down
6 changes: 3 additions & 3 deletions locales/dev/gkhDev_Implementations.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ <h1>Implementations</h1>
<h2>Overview</h2>

<ul>
<li>Legacy (NET4.0 & WinForms based), "GEDKeeper2"
<li>Future cross-platform desktop (NET Standard & <a href="/~https://github.com/picoe/eto"></a>Eto.Forms based), codenamed "GEDKeeper3", interface grinding stage
<li>Future mobile (NET Standard & <a href="/~https://github.com/xamarin/xamarin.forms">Xamarin</a> based), codenamed "GEDKeeperX", initial experience
<li>Legacy (NET4.7.1 & WinForms), "GEDKeeper2"
<li>Future cross-platform desktop (NET6 & <a href="/~https://github.com/picoe/eto"></a>Eto.Forms), codenamed "GEDKeeper3", interface grinding stage
<li>Future mobile (NET Standard & <a href="/~https://github.com/xamarin/xamarin.forms">Xamarin</a>), codenamed "GEDKeeperX", initial experience
</ul>

<h2>Compatibility Matrix</h2>
Expand Down
9 changes: 8 additions & 1 deletion locales/dev/gkhDev_Releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,15 @@ <h1>Releases</h1>
<li>v2.20.0 [28 Mar 2022]
<li>v2.20.1 [14 Apr 2022]
<li>v2.21.0 [28 Aug 2022]
</ul>

<li>v2.22.0 [28 Nov 2022]
<li>v2.23.0 [14 Jan 2023]
<li>v2.24.0 [28 Feb 2023]
<li>v2.25.0 [28 Mar 2023]

<li>v2.25.1 [02 Apr 2023]
<li>v2.25.2/Windows &amp; v3.1.0/Linux [14 Apr 2023]
</ul>

</body>
</html>
Loading

0 comments on commit cdfacc4

Please sign in to comment.