Skip to content

Commit

Permalink
Doc Tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
iwillspeak committed Oct 13, 2021
1 parent 1eb6e47 commit a0bbbf3
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ Feersum is open source software. Contributions are welcome. Please follow a few
simple guidelines to make your contribution extra awesome:

* Small contributions can be submitted as pull requests.
* [Open an issue][open_issue] and discuss
larger changes before cutting code.
* [Open an issue][open_issue] and discuss larger changes before cutting code.

For information on the structure of the compiler, and how to build and test
Feersum yourself check out the [DEVGUIDE][devguide]
Expand All @@ -16,7 +15,8 @@ Seen as I'm sharing the development of this compiler I'd like to reserve the
option to tackle larger issues on stream. If you'd like to make a significant
refactoring to the codebase, or contribute a significant new feature please
[open an issue][open_issue] first so we can discuss. If it isn't on the roadmap
on [the main README][readme] chances are it will be welcome.
on [the main README][readme-roadmap] or part of [a Roadmap issue][roadmap-issues]
chances are it will be welcome.

## Quick Fixes

Expand All @@ -35,6 +35,7 @@ currently claimed and are free to be worked on. If you'd like to tackle one then
shout out in the comments on the issue and I'd be happy to assign it to yo.

[open_issue]: https://github.com/iwillspeak/feersum/issues/new
[readme]: ../README.md
[readme-roadmap]: README.md#planned-features
[up-for-grabs]: https://github.com/iwillspeak/feersum/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22
[roadmap-issues]: https://github.com/iwillspeak/feersum/issues?q=is%3Aopen+is%3Aissue+label%3ARoadmap
[devguide]: DEVGUIDE.md
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,13 @@ and is by no means a guarantee or a strict roadmap.
* [x] Handle multiple parser errors.
* [x] Turn errors in `bind` into diagnotics too.
* [x] Perform on-demand compilation & emit to in-memory assembly for REPL.

Future themes of development are also tracked with
[`Roadmap` issues][roadmap_issues] on GitHub.

[twitch]: https://twitch.tv/iwillspeak
[yt]: https://www.youtube.com/playlist?list=PLCum1jXOlhoRCBewbQD8ELE7B_7EWnWaO
[contributing]: CONTRIBUTING.md
[devguide]: DEVGUIDE.md
[exmaple_gist]: https://gist.github.com/iwillspeak/efc9342c63c07a2a763dd814f555f7ee
[roadmap_issues]: https://github.com/iwillspeak/feersum/issues?q=is%3Aopen+is%3Aissue+label%3ARoadmap
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Example Projects

This folder contains a series of example projects that demonstrate using the
`Feersum.Sdk` BSBuild SDK to compile Scheme code. Each project is an SDK-style
`Feersum.Sdk` MSBuild SDK to compile Scheme code. Each project is an SDK-style
project using `Sdk="Feersum.Sdk"`.

Each project uses the extension `.scmproj`. The SDK then allows scheme code to
be compiled by registering `<Compile Include="..." />` items. Support for
`ProjectReference`, `PackageReference` and other .NET SDK items is provided by
the base `Microsoft.NET.Sdk`. Items can be built, run, and packed with the
the base `Microsoft.NET.Sdk`. Projects can be built, run, and packed with the
`dontet` CLI as usual.

## Hello World
Expand Down

0 comments on commit a0bbbf3

Please sign in to comment.