README: almost a README now

This commit is contained in:
alterNERDtive 2022-05-29 18:06:13 +02:00
parent bdf1dae0dd
commit 48d2d7edc4
2 changed files with 39 additions and 5 deletions

View file

@ -1,4 +1,11 @@
[*.cs]
[*]
guidelines = 80
end_of_line = lf
insert_final_newline = true
charset = utf-8-bom
[*.cs]
guidelines = 80, 120
# IDE0021: Use block body for constructors
csharp_style_expression_bodied_constructors = when_on_single_line

View file

@ -1,13 +1,40 @@
# EDNA
# EDNA An Elite Dangerous System Data Library
FIXXME
EDNA is a library for third party apps that want to access data about star
systems, stations and CMDRs of the game Elite Dangerous. It can query
[EDSM](https://edsm.net), [Spansh](https://spansh.uk) and
[EDTS](http://edts.thargoid.space) for data.
The general idea is that you usually do not care _where_ your data comes from,
so this will get it for you wherever it can depending on data availability and
API features.
**THIS IS A HEAVY WIP PROJECT AND *NOT* READY FOR PRODUCTION USE.** Just saying.
## Why EDNA⁈
Why not. I find it quite funny that most Elite-related project are 4 letter
acronyms starting with “ED”. So I stuck to that, and I had just played “Edna &
Harvey: The Breakout” with the kids. Its not actually an acronym though because
I couldnt come up with a meaning for NA.
## TODO for first proper release
- [ ] README
- [x] README
- [ ] Documentation
- [ ] Spansh API
- [ ] system data
- [ ] nearest system
- [ ] station data
- [ ] outdated stations
- [ ] rest (probably out of scope for now)
- [ ] EDSM API
- [x] Systems
- [x] Logs (CMDR data)
- [ ] Stations (probably out of scope for now)
- [x] EDTS API
- [x] system position
- [ ] convenience layer / unification
- [ ] sanity check / refactoring
- [ ] nuget package
- [ ] Github Actions build / package automation