sean-m
/
schemy
mirror of https://github.com/microsoft/schemy.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added nuget package. Updated README.

pull/2/head
Kefei Lu 2018-04-02 10:43:27 -07:00
parent 8a5a33e1a7
commit 7f9f47618c
2 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -82,10 +82,26 @@ Schemy can be seen as sitting in the middle of the spectrum:
file system](#virtualfs).)
## Usage
Schemy is primarily designed to be embedded into a .NET application for
configuration or as a [shell-like interactive environment (REPL)](#repl). To
use Schemy, you can either:
1. Reference `schemy.dll`, or
2. Copy `src/schemy/*.cs` source code to include in your application. Since
Schemy code base is small. This approach is very feasible (don't forget to
also include the resource file `init.ss`).
To reference `schemy.dll`, either install it via [Nuget
(schemy)](schemy_nuget), or build it from source as described below.
## Build
Simply run `msbuild` in `src/`, or use your favorite IDE.
Schemy does not take any external dependency. So building it should be
straightfoward: simply run `msbuild` in `src/`, or use your favorite IDE.
The project structure looks like so:
@ -101,15 +117,6 @@ The project structure looks like so:
## Embedding and Extending Schemy
Schemy is primarily designed to be embedded into a .NET application for
configuration or as a [shell-like interactive environment (REPL)](#repl). To
use Schemy, you can either:
1. Reference `schemy.dll`, or
2. Copy `src/schemy/*.cs` source code to include in your application. Since
Schemy code base is small. This approach is very feasible (don't forget to
also include the resource file `init.ss`).
The below sections describes how to embed and extend Schemy in .NET
applications and in Scheme scripts. For a comprehensive example, please refer
@ -315,5 +322,6 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
[schemepl]: http://www.scheme.com/tspl4/start.html#./start:h4
[lispy]: http://norvig.com/lispy2.html
[schemy_nuget]: https://www.nuget.org/packages/schemy
<!--- vim: set ft=markdown tw=78: -->

16
src/schemy/schemy.nuspec Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0"?>
<package >
<metadata>
<id>$id$</id>
<version>$version$</version>
<title>$title$</title>
<authors>Microsoft</authors>
<owners>$author$</owners>
<licenseUrl>https://github.com/Microsoft/schemy/blob/master/LICENSE</licenseUrl>
<projectUrl>https://github.com/Microsoft/schemy</projectUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>$description$</description>
<releaseNotes>Initial release</releaseNotes>
<copyright>Copyright 2018</copyright>
</metadata>
</package>