Skip to content

Commit

Permalink
docs(readme): update todo and add differences (tbd.)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dich0tomy committed Mar 2, 2024
1 parent 1dd8414 commit 0215efa
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
> with proper docs and build options.
> [!NOTE]
> This started as a simple port of [dirs-dev/directories-rs](https://github.com/dirs-dev/directories-rs),
> but deviated in the process, the exact details [can be found here](PUT A LINK HERE LOL).
> This started as a simple port of [`dirs-dev/directories-rs`](https://github.com/dirs-dev/directories-rs),
> but deviated in the process, the exact details [can be found here](./docs/differences.md).
A complete cross-platform solution for user and data directories discovery
with OOTB project support.
Expand All @@ -25,11 +25,14 @@ TODO:
- [x] Mac - Nix with { CMake, Meson } x { Gcc, Clang }
- [x] Windows - { CMake, Meson } x MSVC
- [x] Merge PR and go public
- [ ] Change codeowners
- [ ] Add a log() directory
- [ ] Documentation generation
- [ ] Releases on GitHub
- [ ] Add dire executable
- [ ] Add conan and vcpkg packaging methods
- [ ] Releases on GitHub
- [ ] Refactor so far #3
- [ ] Better readme
- [ ] Better readme (diataxis docs)
- [ ] Refactor so far #4

Plans:
Expand Down
19 changes: 19 additions & 0 deletions docs/differences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Differences between this and other implementations

## How it started

This project started because I wanted a nice cross-platform way of discovering typical data directories.

The only feasible alternative I found is [`sago007/PlatformFolders`](https://github.com/sago007/PlatformFolders),
but it's unmaintained for two years now and doesn't necessarily expose the API I'd like to be using.

There's an awesome Rust crate [`dirs-dev/directories-rs`](https://github.com/dirs-dev/directories-rs) which very much
would fit my needs, but it's.. Rust, not C++ - so I wrote this.

## How it differs

TBD.

## Where it's going

TBD.

0 comments on commit 0215efa

Please sign in to comment.