Skip to content

Commit ece1e35

Browse files
authored
Update readme.md
Signed-off-by: 0x5BFA <[email protected]>
1 parent 0924e31 commit ece1e35

File tree

1 file changed

+26
-37
lines changed

1 file changed

+26
-37
lines changed

readme.md

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -95,23 +95,6 @@ if(activeSponsor != null)
9595
}
9696
```
9797

98-
### Codebase Structure
99-
100-
```
101-
.
102-
├──Scripts // Code quality scripts
103-
| └──configure-integration-tests.ps1 // Integration tests configuration script
104-
├──Tools // Code quality tools
105-
| └──Generate // GraphQL .NET entity generator
106-
├──Octokit.GraphQL // Main API data contracts library
107-
├──Octokit.GraphQL.Core // Octokit core code
108-
├──Octokit.GraphQL.Core.Generation // Core entity generator tools
109-
├──Octokit.GraphQL.Core.Generation.UnitTests // Core entity generator unit tests
110-
├──Octokit.GraphQL.Core.UnitTests // Octokit core unit tests
111-
├──Octokit.GraphQL.IntegrationTests // Octokit integration tests
112-
└──Octokit.GraphQL.UnitTests // Octokit unit tests
113-
```
114-
11598
## Contributing & Feedback
11699

117100
There are multiple ways to participate in the community:
@@ -121,31 +104,37 @@ There are multiple ways to participate in the community:
121104
- [File bugs and feature requests](https://github.com/octokit/octokit.graphql.net/issues/new/choose).
122105
- Review source [code changes](https://github.com/octokit/octokit.graphql.net/commits)
123106
124-
## Running tests
125-
126-
### 1️. Prerequisites
127-
128-
Ensure you have following components:
107+
## Building from source
129108

130-
- [Git](https://git-scm.com/)
131-
- [Visual Studio and the .NET SDK](https://visualstudio.microsoft.com/vs/)
109+
### Prerequisites
132110

133-
### 2️. Git
111+
1. Ensure you have following components:
112+
- [Git](https://git-scm.com/)
113+
- [Visual Studio and the .NET SDK](https://visualstudio.microsoft.com/vs/)
114+
2. Clone the repository:
115+
```git
116+
git clone https://github.com/octokit/octokit.graphql.net
117+
```
134118

135-
Clone the repository:
136-
137-
```git
138-
git clone https://github.com/octokit/octokit.graphql.net
139-
```
140-
141-
### 3️. Test the project
119+
### Building the project
142120

143121
- Open `Octokit.GraphQL.sln`.
144-
- Set the Startup Project to `Octokit.GraphQL.UnitTests` or another test project as appropriate
122+
- Set the Startup Project to `Octokit.GraphQL` or a test project as appropriate
145123
- Build with `DEBUG|x64` (or `DEBUG|Any CPU`)
146124

147-
## License
125+
### Codebase structure
148126

149-
Copyright (c) 2018 - present GitHub Inc.
150-
151-
Licensed under the MIT license as stated in the [LICENSE](LICENSE.md).
127+
```
128+
.
129+
├──Scripts // Code quality scripts
130+
| └──configure-integration-tests.ps1 // Integration tests configuration script
131+
├──Tools // Code quality tools
132+
| └──Generate // GraphQL .NET entity generator
133+
├──Octokit.GraphQL // Main API data contracts library
134+
├──Octokit.GraphQL.Core // Octokit core code
135+
├──Octokit.GraphQL.Core.Generation // Core entity generator tools
136+
├──Octokit.GraphQL.Core.Generation.UnitTests // Core entity generator unit tests
137+
├──Octokit.GraphQL.Core.UnitTests // Octokit core unit tests
138+
├──Octokit.GraphQL.IntegrationTests // Octokit integration tests
139+
└──Octokit.GraphQL.UnitTests // Octokit unit tests
140+
```

0 commit comments

Comments
 (0)