From d5e7cf6dbd1153b3121152ef084684915401013e Mon Sep 17 00:00:00 2001 From: Justin Geeslin Date: Thu, 10 Sep 2020 15:53:29 -0500 Subject: [PATCH] Adding build instructions to the README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 8e427c6..757451f 100644 --- a/README.md +++ b/README.md @@ -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`. + +
+Building on Windows + +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` + +
+ +### 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) +