Skip to content

Commit

Permalink
Adding build instructions to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
justingeeslin committed Sep 10, 2020
1 parent bd244cd commit d5e7cf6
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,22 @@ There is a separate repository of documentation, both for end users
and for developers: [https://github.com/cogtool/documentation.git](https://github.com/cogtool/documentation.git)
TODO Merge this seperate repo with the in-branch, GitHub Pages-powered `docs/` folder.

## Building
To compile CogTool,
1. Download the source code from [GitHub](https://github.com/CogTool-Modern/cogtool).
2. Install [Apache Ant](https://ant.apache.org/bindownload.cgi)
3. From within the project directory, run `ant`

Running the `ant` command begins the build process specified in `build.xml`.

<details markdown="1">
<summary>Building on Windows</summary>

The step in the build process for building Windows installers will only happen when building CogTool on Windows. This steps assumes that you have installed [NSIS](https://nsis.sourceforge.io/Main_Page) and the executable is available at `C:\Program Files (x86)\NSIS\makensis.exe`

</details>

### Related
- [CogTool - 32-bit build instructions](https://github.com/cogtool/documentation/blob/master/Processes/configuring-development-machines.txt)
- [Download Apache Ant](https://ant.apache.org/bindownload.cgi)

0 comments on commit d5e7cf6

Please sign in to comment.