Skip to content

Commit 22ee129

Browse files
authored
Updated README (#38)
1 parent f532350 commit 22ee129

File tree

3 files changed

+20
-33
lines changed

3 files changed

+20
-33
lines changed

BUILDING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Cloning
22

3-
Open a terminal window and paste the following command:
3+
Open a new terminal window and paste the following command:
44
```ps
55
git clone --recursive https://github.com/securefolderfs-community/SecureFolderFS.git
66
```
@@ -10,7 +10,7 @@ Running this command will clone the repository with all submodules into the curr
1010
### 1. Prerequisites
1111
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) with the following components installed:
1212
- .NET 7 SDK
13-
- Windows 11 SDK (10.0.22000.0)
13+
- Windows 11 SDK (10.0.22621.0)
1414
- MSVC v143 - VS 2022 C++ x64/x86 or ARM64 build tools (latest)
1515
- [Windows App SDK](https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/downloads#current-releases)
1616

@@ -40,18 +40,18 @@ Running this command will clone the repository with all submodules into the curr
4040
- In the welcome screen, click "Open" and select SecureFolderFS.sln
4141
- Ensure that the following build settings match your configuration (toolbar):
4242
- Selected "Any CPU"<br/>
43-
![image](https://user-images.githubusercontent.com/79316397/216769931-d93fd118-4b9f-4524-b127-1427f9076840.png)
43+
![image](https://github.com/securefolderfs-community/SecureFolderFS/assets/79316397/52f671bc-5c37-4d82-b1fa-f4fb53ada8ef)
4444

4545
- Startup project set to SecureFolderFS.AvaloniaUI<br/>
46-
![image](https://user-images.githubusercontent.com/79316397/216769910-22452492-e60e-4ee9-8ced-8a7313b94cf8.png)
46+
![image](https://github.com/securefolderfs-community/SecureFolderFS/assets/79316397/3a26ba05-db0a-4d1d-ae08-0d5f16072092)
4747
#### Building with Terminal
4848

4949
Open a terminal window and paste the following command:
5050
```ps
5151
dotnet build SecureFolderFS.AvaloniaUI
5252
```
5353

54-
To build Release version of the app, modify the command:
54+
To build Release version of the app, modify the command as follows:
5555
```ps
5656
dotnet build SecureFolderFS.AvaloniaUI -c Release
5757
```

CONTRIBUTING.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# Contributing to SecureFolderFS
22

3-
We welcome all contributions! You can check the [issues tab](https://github.com/securefolderfs-community/SecureFolderFS/issues) and add your feedback on a feature/bug if it has not been submitted yet. We gather user feedback to improve SecureFolderFS however, it doesn't guarantee a ticket to be approved for further development. We always seek constructive conversation and collaboration, we'll notify you on the status update of your issue.
4-
5-
Remember to be respectful and polite. All conversations and interactions must fall within our Code of Conduct.
3+
We welcome all contributions! You can check the *[Issues Tab](https://github.com/securefolderfs-community/SecureFolderFS/issues)* and add your feedback on a feature or a bug if it has not been submitted yet. We gather user feedback to improve SecureFolderFS however, it doesn't guarantee a ticket to be approved for further development. We always seek constructive conversation and collaboration, we'll notify you on the status update of your issue.
64

75
## Before starting work
86

9-
Decide on the feature request / bug report you would like to work on by heading to the [issues tab](https://github.com/securefolderfs-community/SecureFolderFS/issues). Issues marked with `triage approved` and those approved by the team can be developed. Make sure to notify others under the issue's thread to avoid duplicating efforts.
7+
Decide on the feature request or bug report you would like to work on by heading to the *[Issues Tab](https://github.com/securefolderfs-community/SecureFolderFS/issues)*. Issues marked with `triage approved` and those approved by the team can be developed. Make sure to notify others under the issue's thread to avoid duplicating efforts.
108

119
## Opening a pull request
1210

13-
We require pull requests to be well orgainzed and match the exact goal of solved problem. Here are some general rules for pull requests:
11+
We require pull requests to be well organized and match the exact goal of solved problem. Here are some general rules for pull requests:
1412

15-
- Write a good summary of changes you've made
13+
- Write a good summary of changes you have made
1614
- Test your changes to find unwanted bugs or performance regressions
1715
- Associate pull requests with one issue, unless the solved problem applies to multiple tickets
1816
- Don't fix multiple unrelated issues in one pull request, split them into multiple PRs if needed
19-
- Test your changes with [Accessibility Insights](https://accessibilityinsights.io/) (if applicable)
17+
- Test your changes with *[Accessibility Insights](https://accessibilityinsights.io/)* (if applicable)

README.md

+10-21
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,22 @@
44

55
[![Discord](https://discordapp.com/api/guilds/926425949078159420/widget.png)](https://discord.gg/NrTxXpJ2Zj)
66

7-
SecureFolderFS helps you keep your files private. Protect your data with state-of-the-art encryption algorithms that seamlessly secure your data thanks to SecureFolderFS' advanced on-fly encryption/decryption.
7+
SecureFolderFS helps you keep your files private. Safeguard your data with cutting-edge cryptographic algorithms that seamlessly secure your data thanks to our advanced on-fly encryption.
88

9-
![42-19-22-164216](https://user-images.githubusercontent.com/53011783/164031142-0881cddb-683f-4f39-89b0-3788f6c01ac2.png)
9+
![14 05 2023 18_51_03](https://github.com/securefolderfs-community/SecureFolderFS/assets/53011783/5320dfca-6388-46d8-99ab-90a5b3026d0a)
1010

11-
## Get SecureFolderFS
11+
## Try out SecureFolderFS
1212

13-
- [Releases](https://github.com/securefolderfs-community/SecureFolderFS/releases)
13+
You can download and install SecureFolderFS through either of those:
14+
- *[Microsoft Store](https://apps.microsoft.com/store/detail/securefolderfs/9NZ7CZRN7GG8)*
15+
- *[Releases](https://github.com/securefolderfs-community/SecureFolderFS/releases)*
1416

15-
## FAQ
17+
*Installing SecureFolderFS on other platforms is coming in the foreseeable future.*
1618

17-
Check out our [wiki](https://github.com/securefolderfs-community/SecureFolderFS/wiki) for more information.
19+
## Translating SecureFolderFS
1820

19-
## Building
20-
21-
### Prerequisites
22-
23-
- Visual Studio 2022 with the following components:
24-
- .NET desktop development
25-
- Universal Windows Platform development with Windows 11 SDK (10.0.22000.0) and C++ (v143)
26-
- [Single-project MSIX Packaging Tools (VS2022)](https://marketplace.visualstudio.com/items?itemName=ProjectReunion.MicrosoftSingleProjectMSIXPackagingToolsDev17)
27-
28-
### Building the project
29-
30-
- Make sure to set your startup project configuration to SecureFolderFS.WinUI
31-
- Set architecture to match your processor configuration
32-
- Launch the app
21+
The option to translate SecureFolderFS is currently in the works. Soon, you will be able to create localizations for SecureFolderFS. We aim to enable translations in Beta3. Please check back regularly for updates!
3322

3423
## Contributing
3524

36-
SecureFolderFS is open to contributions! You can open an [issue](https://github.com/securefolderfs-community/SecureFolderFS/issues/new/choose) or a [pull request](https://github.com/securefolderfs-community/SecureFolderFS/compare) with your changes. Take a look at [Contributing Guidelines](CONTRIBUTING.md) to make sure your PR matches SecureFolderFS quality standards.
25+
We welcome all contributors! Whether you want to suggest a new feature, or report a bug, you can open a new *[Issue or Feature Request](https://github.com/securefolderfs-community/SecureFolderFS/issues/new/choose)*. Take a look at our *[Contributing Guidelines](CONTRIBUTING.md)* to learn about best practices when creating a new Pull Request.

0 commit comments

Comments
 (0)