Skip to content

Commit

Permalink
chore: Tidy up the house
Browse files Browse the repository at this point in the history
  • Loading branch information
kurosakishigure committed Dec 28, 2024
1 parent 411ad9f commit 1cb2128
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
File renamed without changes.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for contributing to [Katharsis](https://github.com/kurosakishigure/kat

> - Before jumping into a PR be sure to search [existing PRs](https://github.com/kurosakishigure/katharsis/pulls) or [issues](https://github.com/kurosakishigure/katharsis/issues) for an open or closed item that relates to your submission.
> - You need to confirm whether the PR corresponds to an issue. If there isn’t a corresponding issue, please open one before submitting the PR.
> - If you use someone else's code, you should comply with the terms of its license by including the corresponding LICENSE file in the project's [licenses](https://github.com/kurosakishigure/katharsis/tree/canary/licenses) folder. Additionally, make sure to update the project's [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/NOTICE) file with the relevant information. Please be cautious and avoid using code with incompatible licenses.
> - If you use someone else's code, you should comply with the terms of its license by including the corresponding LICENSE file in the project's [licenses](https://github.com/kurosakishigure/katharsis/tree/canary/licenses) folder. Additionally, make sure to update the project's [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/licenses/NOTICE) file with the relevant information. Please be cautious and avoid using code with incompatible licenses.
## Guidelines

Expand All @@ -31,7 +31,7 @@ While these guidelines are not exhaustive, they should help you get started. If

### Code

When you first build the project, [rustup](https://github.com/rust-lang/rustup) will automatically configure the toolchain for you based on the information in the [rust-toolchain.toml](rust-toolchain.toml) file. For more information about the toolchain, please refer to the relevant official documentation:
When you first build the project, [rustup](https://github.com/rust-lang/rustup) will automatically configure the toolchain for you based on the information in the [rust-toolchain.toml](../rust-toolchain.toml) file. For more information about the toolchain, please refer to the relevant official documentation:

- [The toolchain file](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file)
- [rustfmt](https://rust-lang.github.io/rustfmt)
Expand All @@ -42,7 +42,7 @@ When writing code, you need to ensure that you have the corresponding documentat

## Code of Conduct

Do note that our [Code of Conduct](CODE_OF_CONDUCT.md) applies to all Katharsis community channels. Users are **highly encouraged** to read and adhere to them to avoid repercussions.
Do note that our [Code of Conduct](CODE-OF-CONDUCT.md) applies to all Katharsis community channels. Users are **highly encouraged** to read and adhere to them to avoid repercussions.

## Developing

Expand Down
File renamed without changes.
File renamed without changes.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,33 @@

## How to use

Go to [USE.md](https://github.com/kurosakishigure/katharsis/blob/canary/USE.md) to read about how to use Katharsis.
Go to [USE.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/USE.md) to read about how to use Katharsis.

## Installing from Source

If you need to build this project from scratch, please refer to the [INSTALL.md](https://github.com/kurosakishigure/katharsis/blob/canary/INSTALL.md).
If you need to build this project from scratch, please refer to the [INSTALL.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/INSTALL.md).

## Documentation

You can run the `cargo doc --open` command in the root directory of the project to open the web documentation in your browser.

## Contributing

See [CONTRIBUTING.md](https://github.com/kurosakishigure/katharsis/blob/canary/CONTRIBUTING.md).
See [CONTRIBUTING.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/CONTRIBUTING.md).

## Security

We firmly believe that no software is completely secure, and we welcome contributions from security researchers.

See [SECURITY.md](https://github.com/kurosakishigure/katharsis/blob/canary/SECURITY.md).
See [SECURITY.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/SECURITY.md).

## FAQ

See [FAQ.md](https://github.com/kurosakishigure/katharsis/blob/canary/FAQ.md).
See [FAQ.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/FAQ.md).

## Notice

See [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/NOTICE).
See [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/licenses/NOTICE).

## License

Expand Down
6 changes: 3 additions & 3 deletions FAQ.md → docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

When you first run Katharsis on macOS, you might see a system security warning that looks like this:

![Not Opened](assets/faq/not_opened.png)
![Not Opened](../assets/faq/not_opened.png)

This happens because the Katharsis binary was not signed with an Apple Developer Certificate during its build process in the [Actions](https://github.com/kurosakishigure/katharsis/actions/workflows/cd.yml). To resolve this issue, you can use the following steps:

![Allow Anyway](assets/faq/allow_anyway.png)
![Allow Anyway](../assets/faq/allow_anyway.png)

### Plan 2

If you prefer, you can also choose to install from source. For detailed instructions, please refer to [INSTALL.md](INSTALL.md).

> In the future, we plan to address this problem by enabling installation of Katharsis through package managers like [brew](https://brew.sh). If you're interested in helping us implement this feature, you can contribute by following the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).
> In the future, we plan to address this problem by enabling installation of Katharsis through package managers like [brew](https://brew.sh). If you're interested in helping us implement this feature, you can contribute by following the guidelines in [CONTRIBUTING.md](../.github/CONTRIBUTING.md).
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions NOTICE → licenses/NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ NOTICE
This project includes third-party code under the following licenses:

- MIT License:
License: licenses/delta/LICENSE
License: delta/LICENSE
Repository: https://github.com/dandavison/delta
Copyright 2020 Dan Davison
- MIT License:
License: licenses/nextjs/license.md
License: nextjs/license.md
Repository: https://github.com/vercel/next.js
Copyright (c) 2024 Vercel, Inc.
- Apache License:
License: licenses/sharp/LICENSE
License: sharp/LICENSE
Repository: https://github.com/lovell/sharp
Copyright 2024 Lovell Fuller
- Apache License:
License: licenses/material-design-icons/LICENSE
License: material-design-icons/LICENSE
Repository: https://github.com/google/material-design-icons
Copyright (c) 2024 Google, Inc.
- MIT License:
License: licenses/tokio/LICENSE
License: tokio/LICENSE
Repository: https://github.com/tokio-rs/tokio
Copyright (c) Tokio Contributors

0 comments on commit 1cb2128

Please sign in to comment.