Skip to content

Commit f7fd569

Browse files
valentinbreizvalentinbreiz
authored
Merge pull request #2907 from CosmosOS/zarlo/docs/0
working on docs to make it a bit more useable
2 parents 4cde93d + aaa42b0 commit f7fd569

File tree

7 files changed

+128
-37
lines changed

7 files changed

+128
-37
lines changed

‎Docs/articles/Installation/DevKit.md‎

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,59 @@
11
# Dev Kit Installation
22

3-
### Prerequisites for Windows
3+
## Windows
4+
5+
### Prerequisites
46

57
* (Free) source code of Development Kit from [Cosmos on GitHub](https://github.com/CosmosOS/Cosmos)
68
* You must clone the repository using Git. For a detailed walkthrough, [see here](https://help.github.com/articles/fork-a-repo/).
79
* (Free) [Visual Studio 2022 Community](https://visualstudio.microsoft.com/vs/)
810
* (Free) [InnoSetup](http://www.jrsoftware.org/isdl.php#qsp)
911
* This is required to build the setup kit which is used to build and install the Visual Studio integration libaries for Cosmos.
10-
* During install it will ask you about optional components to install. Be sure you check "Install Inno Setup Preprocessor".
12+
* During install it will ask you about optional components to install. Be sure you check "Install Inno Setup Preprocessor".
13+
14+
### Installation
15+
16+
* Look in the downloaded sources and run **install-VS2022.bat** with admin privileges (UAC will ask for permission), needed for install in system directories.
17+
* When the installation is complete, Visual Studio will automatically open and you may begin programming with your new, modified copy of Cosmos.
18+
1119

12-
### Prerequisites for Linux
20+
## Linux
21+
22+
### Prerequisites
1323

1424
* .NET SDK (6+): [Download .NET SDK](https://learn.microsoft.com/en-us/dotnet/core/install/linux)
1525
* Make (`apt install make`)
1626
* Yasm (`apt install yasm`)
1727
* Xorriso (`apt install xorriso`)
1828
* QEMU or any other virtual machine. See [Running](https://cosmosos.github.io/articles/Installation/Running.html) for more information.
1929

20-
### Installation on Windows
2130

22-
* Look in the downloaded sources and run **install-VS2022.bat** with admin privileges (UAC will ask for permission), needed for install in system directories.
23-
* When the installation is complete, Visual Studio will automatically open and you may begin programming with your new, modified copy of Cosmos.
24-
25-
### Installation on Linux
31+
### Installation
2632
Run `make` to build Cosmos. Cosmos will clone all the required repos, build itself, and install it and it's nuget packages to the system automatically.
2733

34+
## notes / FAQ
35+
36+
### custom cosmos repos
37+
38+
if you are using custom cosmos repos you will need to clone them all manually as the installer script will pull from https://github.com/CosmosOS/
39+
40+
A tree diagram of the source should look like the following:
41+
42+
<img src="https://raw.githubusercontent.com/CosmosOS/Cosmos/master/Docs/images/Dir.png" width="200">
43+
44+
45+
### get stuck pulling the git repos
46+
47+
check if git is installed and in your path as we use git to pull the repos
48+
49+
### i just updated and my project is sill using the old version
50+
51+
you may need to clear you nuget cache try ``dotnet clean`` to clear the project level cache
52+
53+
### the project templates are not showing in visual studio
54+
55+
if you have more then 1 version of visual studio installed this can bug this follow "dotnet Project Templates" should fix it
56+
2857
### dotnet Project Templates
2958
If you are using linux or prefer not using Visual Studio for your projects, you can install the dotnet project template using `dotnet new --install ./source/templates/csharp/` assuming you are currently in the Cosmos base directory.
3059
After installing the template use `dotnet new cosmosCSKernel -n {name}` to create a new Cosmos Kernel project.

‎Docs/articles/Installation/UserKit.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Installation
2+
3+
for DevKit / linux see [DevKit](DevKit.md)
4+
5+
### Prerequisites
6+
7+
8+
* **Visual Studio 2022** - [Download](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)
9+
* **Visual Studio 2022 Workload: .NET Desktop** - .NET Desktop development
10+
* **.NET 6.0** - [Download](https://www.microsoft.com/en-us/download/details.aspx?id=53321)
11+
* **VMware Player or Workstation** VMware Player is free, so that is recommended instead - [Download](https://www.vmware.com/uk/products/workstation-player/workstation-player-evaluation.html)
12+
* **Microsoft Visual C++ 2010 Redistributable** - [Download](https://www.microsoft.com/en-us/download/details.aspx?id=26999)
13+
14+
### Installing Cosmos
15+
16+
First, you need to choose between the User Kit and the Dev Kit. It is recommended that new users start with the User Kit but only move later to the Dev Kit if you need the latest features and want to contribute back to the main project.
17+
The Dev Kit is the live source against which the Cosmos Team develops directly. The Dev Kit has the latest and greatest features, but at various times has known issues, and sometimes may not even build. Thus to use the Dev Kit be sure to join our support channels and inquire about the current status before using the Dev Kit or updating it.
18+
19+
The User Kit is a snapshot stable version of Cosmos including a premade installer. The UserKit however is often quite a bit out of date compared to the DevKit and is only occasionally updated. The User Kit is a great easy way to get familiar with Cosmos, but active developers should transition to the Dev Kit after becoming very familiar with the UserKit, and expect some bugs here and there.
20+
21+
### User Kit
22+
23+
1. Download [the latest release of Cosmos](http://github.com/CosmosOS/Cosmos/releases/latest) (download the **exe** file)
24+
2. Wait for the download to complete then run the installer. Allow it to run as admin. Make sure **VS2022 is NOT running** when you do this.
25+
3. Click "Next" then "Install"
26+
4. Wait for the install to progress. **Tip:** At the end the installer may look like it has stalled, but it is still doing something in the background. WAIT for the "Finish" button to become available.
27+
5. Cosmos should now be installed. Follow other tutorials to find out how to create your first OS.

‎Docs/articles/toc.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
## [Debug Commands](Debugger/DebugCommands.md)
99

1010
# Installation
11+
## [User Kit](Installation/UserKit.md)
1112
## [Dev Kit](Installation/DevKit.md)
1213
## [Running](Installation/Running.md)
1314

‎Docs/docfx.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,42 @@
1414
}
1515
],
1616
"dest": "obj/api"
17+
},
18+
{
19+
"src": [
20+
{
21+
"files": [
22+
"source/Cosmos.Core/Cosmos.Core.csproj",
23+
"source/Cosmos.Core_Asm/Cosmos.Core_Asm.csproj",
24+
"source/Cosmos.HAL2/Cosmos.HAL2.csproj",
25+
"source/Cosmos.System2/Cosmos.System2.csproj",
26+
"source/Cosmos.Debug.Kernel/Cosmos.Debug.Kernel.csproj",
27+
],
28+
"exclude": [
29+
"**/bin/**",
30+
"**/obj/**"
31+
],
32+
"src": "../"
33+
}
34+
],
35+
"dest": "obj/api/cosmos"
36+
},
37+
{
38+
"src": [
39+
{
40+
"files": [
41+
"source/Cosmos.Core_Plugs/Cosmos.Core_Plugs.csproj",
42+
"source/Cosmos.HAL2/Cosmos.HAL2.csproj",
43+
"source/Cosmos.System2_Plugs/Cosmos.System2_Plugs.csproj"
44+
],
45+
"exclude": [
46+
"**/bin/**",
47+
"**/obj/**"
48+
],
49+
"src": "../"
50+
}
51+
],
52+
"dest": "obj/api/plugs"
1753
}
1854
],
1955
"build": {
@@ -25,6 +61,20 @@
2561
"src": "obj/api",
2662
"dest": "api"
2763
},
64+
{
65+
"files": [
66+
"**/*.yml"
67+
],
68+
"src": "obj/api/cosmos",
69+
"dest": "api/cosmos"
70+
},
71+
{
72+
"files": [
73+
"**/*.yml"
74+
],
75+
"src": "obj/api/plugs",
76+
"dest": "api/plugs"
77+
},
2878
{
2979
"files": [
3080
"**/*.md",

‎Docs/index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Welcome to the Official Cosmos Documentation</h1>
22

3-
If you're new to Cosmos, welcome! Before you get stuck in the API documentation, we highly recommend you visit the website linked at the bottom.
3+
If you're new to Cosmos, welcome! Before you get stuck in the API documentation, we highly recommend you visit the website linked below.
44

5-
The Articles section of this website includes some articles which have been written many years ago for websites such as www.codeproject.com and are kept for archival purposes. These discuss elements such as the Cosmos Virtual File System. We prefer newcomers who want to develop their own operating systems to read the API documentation while we update these articles to comply with the current Cosmos project.
5+
The Articles section of this website includes some articles which have been written over years ago for websites such as www.codeproject.com and are mostly kept for archival purposes. These discuss elements such as the Cosmos Virtual File System. We prefer newcomers who want to develop their own operating systems to read the API documentation while we update these articles to comply with the current Cosmos project.
66

77
For projects using the VFS directly, we recommend you use System.IO methods where possible. This is because these were written before much progress was made making .NET assemblies usable
88

@@ -17,4 +17,6 @@ If you need a translation for this documentation, click [here](https://cosmosos-
1717
You can find the latest and previous build statuses on [AppVeyor](https://ci.appveyor.com/project/CosmosOS/cosmos)
1818

1919
[![Build status](https://ci.appveyor.com/api/projects/status/kust7g5dlnykhkaf/branch/master?svg=true)](https://ci.appveyor.com/project/CosmosOS/cosmos/branch/master)
20-
[![Join the chat at (https://discord.com/invite/kwtBwv6jhD](https://img.shields.io/discord/833970409337913344)](https://discord.com/invite/kwtBwv6jhD)
20+
[![Join the chat at (https://discord.com/invite/kwtBwv6jhD](https://img.shields.io/discord/833970409337913344)](https://discord.com/invite/kwtBwv6jhD)
21+
22+
xref link [https://cosmosos.github.io/xrefmap.yml](https://cosmosos.github.io/xrefmap.yml)

‎Docs/install.md‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,4 @@
1-
# Installation
21

3-
### Prerequisites
4-
5-
6-
* **Visual Studio 2022** - [Download](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)
7-
* **Visual Studio 2022 Workload: .NET Desktop** - .NET Desktop development
8-
* **.NET 6.0** - [Download](https://www.microsoft.com/en-us/download/details.aspx?id=53321)
9-
* **VMware Player or Workstation** VMware Player is free, so that is recommended instead - [Download](https://www.vmware.com/uk/products/workstation-player/workstation-player-evaluation.html)
10-
* **Microsoft Visual C++ 2010 Redistributable** - [Download](https://www.microsoft.com/en-us/download/details.aspx?id=26999)
11-
12-
### Installing Cosmos
13-
14-
First, you need to choose between the User Kit and the Dev Kit. It is recommended that new users start with the User Kit but only move later to the Dev Kit if you need the latest features and want to contribute back to the main project.
15-
The Dev Kit is the live source against which the Cosmos Team develops directly. The Dev Kit has the latest and greatest features, but at various times has known issues, and sometimes may not even build. Thus to use the Dev Kit be sure to join our support channels and inquire about the current status before using the Dev Kit or updating it.
16-
17-
The User Kit is a snapshot stable version of Cosmos including a premade installer. The UserKit however is often quite a bit out of date compared to the DevKit and is only occasionally updated. The User Kit is a great easy way to get familiar with Cosmos, but active developers should transition to the Dev Kit after becoming very familiar with the UserKit, and expect some bugs here and there.
18-
19-
### User Kit
20-
21-
1. Download [the latest release of Cosmos](http://github.com/CosmosOS/Cosmos/releases/latest) (download the **exe** file)
22-
2. Wait for the download to complete then run the installer. Allow it to run as admin. Make sure **VS2022 is NOT running** when you do this.
23-
3. Click "Next" then "Install"
24-
4. Wait for the install to progress. **Tip:** At the end the installer may look like it has stalled, but it is still doing something in the background. WAIT for the "Finish" button to become available.
25-
5. Cosmos should now be installed. Follow other tutorials to find out how to create your first OS.
262

273
### Dev Kit
284

‎Docs/toc.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
- name: Home
22
href: index.md
33
- name: Install
4-
href: install.md
4+
href: articles/Installation/UserKit.md
55
- name: Cosmos Website
66
href: https://gocosmos.org
77
- name: Articles
88
href: articles/
99
homepage: articles/GettingStarted.md
1010
- name: API Documentation
11-
href: obj/api/
11+
items:
12+
- name: Cosmos
13+
href: obj/api/cosmos
14+
- name: X#
15+
href: obj/api/xsharp
16+
- name: IL2CPU
17+
href: obj/api/il2cpu

0 commit comments

Comments
 (0)