Update README with state of project, screenshots

This commit is contained in:
Brandon Rhodes 2021-02-09 11:07:04 -05:00
parent 2207f987f2
commit 16c59109d9
2 changed files with 54 additions and 3 deletions

3
README
View File

@ -1,3 +0,0 @@
Welcome to XEphem, an interactive astronomy program for all UNIX platforms.
Start with the INSTALL file.

54
README.md Normal file
View File

@ -0,0 +1,54 @@
# Welcome to XEphem!
XEphem is an interactive astronomy program for all UNIX platforms.
![Sky view](/GUI/xephem/help/png/sky-view.png?raw=true)
More screenshots are shown below.
* Documentation lives at <https://www.clearskyinstitute.com/xephem/>
where Elwood Downey —
XEphems original author and its maintainer since the 1990s —
offers a manual, data files, and user contributed scripts.
* Elwood Downey has generously released XEphem under the MIT License!
An “XEphem” organization has been created on GitHub
to host XEphems [source code](https://github.com/XEphem/XEphem).
* The XEphem community hopes to modernize the code
to make it easier to compile, package, and run on modern systems.
In the meantime,
XEphem compiles most readily on older Linux platforms
like Ubuntu 14.04.
* If you want to get started immediately,
a Docker image
that successfully compiles and runs XEphem atop Ubuntu 14.04
is available in the “docker” branch on GitHub.
Its documented
[in this README file](https://github.com/XEphem/XEphem/blob/docker/container/README.md).
* Otherwise,
if you want to tackle XEphem development on another platform,
start with the
[INSTALL](https://github.com/XEphem/XEphem/blob/main/INSTALL)
file in the `main` branch of the repository.
* Direct questions to the main repositorys
[GitHub Discussions](https://github.com/XEphem/XEphem/discussions)
by clicking “New discussion” and writing up your question.
A few more screenshots:
![Sun view](/GUI/xephem/help/png/sun-view.png?raw=true)
![Solar system view](/GUI/xephem/help/png/solsys.png?raw=true)
![Saturn and its moons](/GUI/xephem/help/png/saturn.png?raw=true)
![Binary star view](/GUI/xephem/help/png/sky-binary.png?raw=true)
![Moon view](/GUI/xephem/help/png/moon.png?raw=true)
![Earth view](/GUI/xephem/help/png/earth.png?raw=true)