From d02039c78fd3e034d48bce87f6b0c879d24a68df Mon Sep 17 00:00:00 2001 From: Don Cross Date: Tue, 23 Nov 2021 20:43:17 -0500 Subject: [PATCH] Trying to make it easier for newcomers to find the code. I'm concerned that a first-time visitor to the Astronomy Engine repo on GitHub will get lost. I made it more obvious where to quickly find the source code needed for a given language. --- README.md | 10 +++++----- csdown/csharp_prefix.md | 3 +++ hydrogen/c_prefix.md | 3 +++ jsdoc2md/js.hbs | 7 +++++++ pydown/py_prefix.md | 3 +++ source/c/README.md | 3 +++ source/csharp/README.md | 3 +++ source/js/README.md | 7 +++++++ source/python/README.md | 3 +++ 9 files changed, 37 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cd5506d7..c728aac5 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,11 @@ Examples - Documentation - Documentation - Documentation - Documentation - Documentation + Code & Docs + Code & Docs + Code & Docs + Code & Docs + Code & Docs diff --git a/csdown/csharp_prefix.md b/csdown/csharp_prefix.md index 7346e8ce..74cfe6fb 100644 --- a/csdown/csharp_prefix.md +++ b/csdown/csharp_prefix.md @@ -7,6 +7,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own C# program, all you need is the +file `astronomy.cs` from this directory. + To get started quickly, here are some [examples](../../demo/csharp/). --- diff --git a/hydrogen/c_prefix.md b/hydrogen/c_prefix.md index 93b37be3..6ffbd407 100644 --- a/hydrogen/c_prefix.md +++ b/hydrogen/c_prefix.md @@ -8,6 +8,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own C or C++ program, all you need are the +files `astronomy.h` and `astronomy.c` from this directory. + To get started quickly, here are some [examples](../../demo/c/). --- diff --git a/jsdoc2md/js.hbs b/jsdoc2md/js.hbs index 7278ec31..c1e220ca 100644 --- a/jsdoc2md/js.hbs +++ b/jsdoc2md/js.hbs @@ -13,6 +13,13 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To use Astronomy Engine in your own project, you can use the TypeScript file `astronomy.ts` +from this directory. + +For convenience, this directory also contains human-readable JavaScript files `astronomy.js` +and minified versions for the browser (`astronomy.browser.min.js`) and Node.js (`astronomy.min.js`). +These JavaScript sources are all compiled from the TypeScript source `astronomy.ts`. + To get started quickly, here are some [browser scripting examples](../../demo/browser/) and some [Node.js examples](../../demo/nodejs/). diff --git a/pydown/py_prefix.md b/pydown/py_prefix.md index 849bda76..8175d97f 100644 --- a/pydown/py_prefix.md +++ b/pydown/py_prefix.md @@ -7,6 +7,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own Python program, all you need is +the file `astronomy.py` from this directory. + To get started quickly, here are some [examples](../../demo/python/). --- diff --git a/source/c/README.md b/source/c/README.md index d4147fa9..64eb7653 100644 --- a/source/c/README.md +++ b/source/c/README.md @@ -8,6 +8,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own C or C++ program, all you need are the +files `astronomy.h` and `astronomy.c` from this directory. + To get started quickly, here are some [examples](../../demo/c/). --- diff --git a/source/csharp/README.md b/source/csharp/README.md index 960f4320..1b25e843 100644 --- a/source/csharp/README.md +++ b/source/csharp/README.md @@ -7,6 +7,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own C# program, all you need is the +file `astronomy.cs` from this directory. + To get started quickly, here are some [examples](../../demo/csharp/). --- diff --git a/source/js/README.md b/source/js/README.md index b2093c65..008db621 100644 --- a/source/js/README.md +++ b/source/js/README.md @@ -13,6 +13,13 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To use Astronomy Engine in your own project, you can use the TypeScript file `astronomy.ts` +from this directory. + +For convenience, this directory also contains human-readable JavaScript files `astronomy.js` +and minified versions for the browser (`astronomy.browser.min.js`) and Node.js (`astronomy.min.js`). +These JavaScript sources are all compiled from the TypeScript source `astronomy.ts`. + To get started quickly, here are some [browser scripting examples](../../demo/browser/) and some [Node.js examples](../../demo/nodejs/). diff --git a/source/python/README.md b/source/python/README.md index 0ce19994..cfc32772 100644 --- a/source/python/README.md +++ b/source/python/README.md @@ -7,6 +7,9 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info. --- ## Quick Start +To include Astronomy Engine in your own Python program, all you need is +the file `astronomy.py` from this directory. + To get started quickly, here are some [examples](../../demo/python/). ---