aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29e634c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# SwiftChessNeo
+
+**WIP: I am actively developing swift-chess-neo while writing iWatchChess for iOS/macOS**
+
+Fork of [https://github.com/nvzqz/Sage](Sage by @nvzqz) along with [https://github.com/SuperGeroy](@SuperGeroy)'s patches. This fork adds SwiftUI views, and other QoL improvements. Due to some technical difficulties, I ended up copying the files in the `Sources` folder and adding them to my project.
+
+## To-Do
+
+- [ ] SwiftUI Views (In-Progress)
+- [ ] UCI Chess Engine Support
+- [ ] SVG Resources
+- Move Handling
+ - [ ] Enhance PGN Parsing
+ - [ ] Comprehensive PGN Support
+ - [ ] Support for different lines
+- [ ] GameplayKit Support
+
+
+### Possible Misc Enhancements
+
+- Integrated Lichess Client (?)
+- Player Database (?)
+
+## License
+
+Sage and its modifications are published under [version 2.0 of the Apache License](https://www.apache.org/licenses/LICENSE-2.0).
+