Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
OetkenPurveyorOfCode committed Feb 4, 2024
1 parent 84fd1b7 commit 41e8f93
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# addtopath
Adds the first argument to USER PATH environment variable without truncating it like setx.
<div id="addtopath-logo" align="center">
<br />
<img src="./logos/addtopath.svg" alt="AddToPath Logo" width="200"/>
<h1>Add To Path</h1>
<h3>Adds the first argument to USER PATH environment variable without truncating it like setx.</h3>
</div>

This program only works on windows.
> [!NOTE]
> This program only works on windows.
# Why does this exist

The default `setx` programme truncated my environment variable without my permission. It gave no prior indication that it would do that. Bad `setx`!

# Usage
```
Expand Down Expand Up @@ -31,6 +40,7 @@ Building with Zig:
```
zig cc main.c -o main.exe
```
Or use your own Docker-ised Cmake remote build generator Meta-Meta-Build-System compiling to autotools with Perl-orchestrated Perforce Jamfiles cross-compiled to Meson.

# Contributing
For contributions make sure that the source compiles with no errors or warnings and use the following compiler flags: Example clang:
Expand All @@ -39,3 +49,15 @@ clang -D_CRT_SECURE_NO_WARNINGS -Wno-newline-eof -Wall -Wextra
-Wshadow -Wconversion -pedantic -Wsign-conversion -Wmisleading-indentation -Wnull-dereference -Wimplicit-fall
through -fsanitize=address -fsanitize=undefined main.c -o main.exe
```

# License:

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
13 changes: 13 additions & 0 deletions logos/addtopath.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41e8f93

Please sign in to comment.