Skip to content

Commit

Permalink
Update documentation for Rust (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
sonnyp authored Dec 16, 2023
1 parent a9d31b5 commit b787136
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# EditorConfig is awesome: http://EditorConfig.org

root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

[{Makefile,**.mk}]
indent_style = tab

[*.py]
indent_size = 4
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,8 @@ demos/**/workbench.vala
demos/**/main.ui
demos/**/libworkbenchcode.so
demos/**/__pycache__
demos/**/Cargo.lock
demos/**/Cargo.toml
demos/**/lib.rs
demos/**/workbench.rs
demos/**/biome.json
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,14 @@ Some guidelines
- Follow the patterns of existing entries
- Follow [the Style Guide](./STYLEGUIDE.md)

⚠️ If you are contributing to Rust please do the following:

```sh
cd demos
flatpak override --user --filesystem=$PWD re.sonny.Workbench
# restart Workbench
```

## Create Library entry

To create a new Library entry, duplicate an existing one and proceed to the next section.
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ This is the repository containing the Library demos of [Workbench](https://githu
5. Make changes
6. Open a pull request

⚠️ If you are contributing to Rust please do the following:

```sh
cd demos
flatpak override --user --filesystem=$PWD re.sonny.Workbench
# restart Workbench
```

For more details see [CONTRIBUTING.md](./CONTRIBUTING.md).

## Code of conduct
Expand Down

0 comments on commit b787136

Please sign in to comment.