Rewrote readme and develop files to include instructions closer to what I assume how it works.
I have no idea how the docker setup works since at quick glance it uses some syntax I don't know and relies on hardcoded image references, which is not good for local development.
Updates
README.md:
added level 1 heading.
removed submodule-related logic since it looks like the repo doesn't use it because there is no .gitmodules file to declare them and archiver folder is empty.
removed pre-commit install logic since it has to be run only for development and only after creating a virtual environment.
added --interactive flag to all cp examples in order not to overwrite the file in case it exists already.
where applicable replaced short-form CLI options with long-form ones.
moved all inline comments outside of shell code blocks.
removed virtualenv --upgrade-embed-wheels because it doesn't in fact makes managing python versions easier.
docs/Develop.md -> docs/develop.md:
basically the same as README.md changes but with more detailed instructions for development.
.vscode/extensions.json:
"ms-python.vscode-pylance" is included along with "ms-python.python" so no reason to rec separately.
"ms-toolsai.jupyter" is same as above.
"rioj7.command-variable" is not relevant anymore.
.vscode/settings.json:
removed "json,schemas" settings because it doesn't look like json schemas are used anyway.
removed python.linting.* settings because they live in a separate extension now.
configs/workspace.code-workspace.example:
removed archiver workspace
removed length-related settings since they don't make sense without some root config set up first.
Deletions
archiver
Is not used anymore.
.github/workflows/build.yml
Has references to OpenYiff github org so I assume it's not relevant anymore.
.vscode/launch.json
Not relevant anymore.
doc/Setup.md
Outdated and the setup instructions are not big enough to warrant a separate file.
json-schema
The repo doesn't seem to use json schema so these files are completely irrelevant.
@honcho
I also wanted to nuke a bunch of errant files which obviously don't look like are used by the repo.
Do I add those changes in this PR or create another one?
honcho commented 6 months ago
Thanks for the pull request. Feel free to clear out the old Kemocruft in this one.
Rewrote readme and develop files to include instructions closer to what I assume how it works.<br>
I have no idea how the docker setup works since at quick glance it uses some syntax I don't know and relies on hardcoded image references, which is not good for local development.
## Updates
- `README.md`:
- added level 1 heading.
- removed submodule-related logic since it looks like the repo doesn't use it because there is no `.gitmodules` file to declare them and `archiver` folder is empty.
- removed `pre-commit` install logic since it has to be run only for development and only after creating a virtual environment.
- added `--interactive` flag to all `cp` examples in order not to overwrite the file in case it exists already.
- where applicable replaced short-form CLI options with long-form ones.
- moved all inline comments outside of shell code blocks.
- removed `virtualenv --upgrade-embed-wheels` because it doesn't in fact makes managing python versions easier.
- `docs/Develop.md` -> `docs/develop.md`:
- basically the same as `README.md` changes but with more detailed instructions for development.
- `.vscode/extensions.json`:
- `"ms-python.vscode-pylance"` is included along with `"ms-python.python"` so no reason to rec separately.
- `"ms-toolsai.jupyter"` is same as above.
- `"rioj7.command-variable"` is not relevant anymore.
- `.vscode/settings.json`:
- removed `"json,schemas"` settings because it doesn't look like json schemas are used anyway.
- removed `python.linting.*` settings because they live in a separate extension now.
- `configs/workspace.code-workspace.example`:
- removed `archiver` workspace
- removed length-related settings since they don't make sense without some root config set up first.
## Deletions
- `archiver`<br>
Is not used anymore.
- `.github/workflows/build.yml`<br>
Has references to `OpenYiff` github org so I assume it's not relevant anymore.
- `.vscode/launch.json`<br>
Not relevant anymore.
- `doc/Setup.md`<br>
Outdated and the setup instructions are not big enough to warrant a separate file.
- `json-schema` <br>
The repo doesn't seem to use json schema so these files are completely irrelevant.
Merges pull request #1
Rewrote readme and develop files to include instructions closer to what I assume how it works.
I have no idea how the docker setup works since at quick glance it uses some syntax I don't know and relies on hardcoded image references, which is not good for local development.
Updates
README.md
:.gitmodules
file to declare them andarchiver
folder is empty.pre-commit
install logic since it has to be run only for development and only after creating a virtual environment.--interactive
flag to allcp
examples in order not to overwrite the file in case it exists already.virtualenv --upgrade-embed-wheels
because it doesn't in fact makes managing python versions easier.docs/Develop.md
->docs/develop.md
:README.md
changes but with more detailed instructions for development..vscode/extensions.json
:"ms-python.vscode-pylance"
is included along with"ms-python.python"
so no reason to rec separately."ms-toolsai.jupyter"
is same as above."rioj7.command-variable"
is not relevant anymore..vscode/settings.json
:"json,schemas"
settings because it doesn't look like json schemas are used anyway.python.linting.*
settings because they live in a separate extension now.configs/workspace.code-workspace.example
:archiver
workspaceDeletions
archiver
Is not used anymore.
.github/workflows/build.yml
Has references to
OpenYiff
github org so I assume it's not relevant anymore..vscode/launch.json
Not relevant anymore.
doc/Setup.md
Outdated and the setup instructions are not big enough to warrant a separate file.
json-schema
The repo doesn't seem to use json schema so these files are completely irrelevant.