lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mhern...@apache.org
Subject [1/5] git commit: adding build docs
Date Sat, 19 Jul 2014 20:42:04 GMT
Repository: lucenenet
Updated Branches:
  refs/heads/pcl 4e3985060 -> d416bcc1a


adding build docs


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/621aacdd
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/621aacdd
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/621aacdd

Branch: refs/heads/pcl
Commit: 621aacdded1158d344006f218fd6c5ff3ead9393
Parents: 4e39850
Author: Michael Herndon <mherndon@michaelherndon.com>
Authored: Fri Jul 18 23:54:28 2014 -0400
Committer: Michael Herndon <mherndon@michaelherndon.com>
Committed: Fri Jul 18 23:54:28 2014 -0400

----------------------------------------------------------------------
 README.md     |  4 ++++
 build.fsx     |  2 +-
 docs/build.md | 22 ++++++++++++++++++++++
 3 files changed, 27 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/621aacdd/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c5e04ab..d2ad9f4 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,10 @@ $ cd path/to/lucene.net/tests/Lucene.Net.Core.Tests
 $ k test
  ```
 
+## Build Scripts
+ * uses FAKE
+ * see [build docs](docs/build.md)
+
 
 ## Milestone 1
  * Implement Build Scripts with [Fake](http://fsharp.github.io/FAKE/)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/621aacdd/build.fsx
----------------------------------------------------------------------
diff --git a/build.fsx b/build.fsx
index fb707fe..0472d35 100644
--- a/build.fsx
+++ b/build.fsx
@@ -111,4 +111,4 @@ Target "Default" (fun _ ->
     ==> "Test:Core"
     ==> "Default"
 
-RunTargetOrDefault "Default"
+RunTargetOrDefault "Default"
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/621aacdd/docs/build.md
----------------------------------------------------------------------
diff --git a/docs/build.md b/docs/build.md
new file mode 100644
index 0000000..0c5cf58
--- /dev/null
+++ b/docs/build.md
@@ -0,0 +1,22 @@
+# Building Lucene.NET
+
+* open command line or terminal
+* <code>$ cd path/to/lucene.net</code>
+* Windows
+    * <code>$ build </code> "Default" is implied
+    * <code>$ build Restore</code> restores packages from nuget
+* Linux
+     * <code>$ sh build.sh </code> "Default" is implied
+     * <code>$ sh build.sh Restore </code> restores the packages from nuget.

+
+## List of Targets
+
+ * __Build:Core__ builds the project found in ./src/Lucene.Net.Core/
+ * __Build:TestingFramework__ builds the project found in ./test/Lucene.Net.TestingFramework/
+ * __Build:Core:Tests__ builds the project found in ./test/Lucene.Net.Core.Tests/
+ * __Clean__ create/cleans the build directory.
+ * __Default__ runs the default build pipeline.
+ * __Restore__ pulls / restores packages from nuget.
+ * __Test:Core__ runs the tests found in ./test/Lucene.Net.Core.Tests
+
+[Back](../README.md)
\ No newline at end of file


Mime
View raw message