Skip to content

Commit b18f0e7

Browse files
committedFeb 15, 2020
Updated Readme and CONTRIBUTING guide
1 parent dd0f44c commit b18f0e7

File tree

2 files changed

+26
-14
lines changed

2 files changed

+26
-14
lines changed
 

‎CONTRIBUTING.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to uDevkit
1+
# Contributing to UDTStudio
22

33
:+1: We are happy to learn that you want to contribute !
44

@@ -9,44 +9,47 @@ This little guide goals to help you to contribute to this project.
99
Before contributing, never forget the following points:
1010

1111
* Keep the lightweight and fast opening of the tool
12-
*
1312

1413
## How Can I Contribute?
1514

16-
* Reporting bugs in [Issues](https://github.com/UniSwarm/uDevkit-IDE/issues)
15+
* Reporting bugs in [Issues](https://github.com/UniSwarm/UDTStudio/issues)
1716

18-
* Pull requests in [Pull requests](https://github.com/UniSwarm/uDevkit-IDE/pulls)
17+
* Pull requests in [Pull requests](https://github.com/UniSwarm/UDTStudio/pulls)
1918

2019
## Styleguides
2120

2221
### Git commit messages
2322

24-
* Use past tense: `Updated funtion getSensor`
23+
* Use past tense: `Updated function getSensor, with better scaling result`
2524

2625
* Include the part of project modified between square brackets.
2726

2827
* `[project] msg` For a modification inside project model
2928

29+
* Never use message like : `Fixed bug` or `Updated project`
30+
31+
* Do only one modification per commit, not two differents bug fix
32+
3033
### C++ code styleguide
3134

3235
* no tab, only spaces, 4 spaces
33-
* headers files with .h extension, .cpp for code files
36+
* headers files with .h extension, .cpp for code files, no upper case in file name
3437
* class name start with a capital and are in camel case style
3538
* private and protected members start with an underscore and a lowercase, camel case style
3639
* getters have the same name than the member without the underscore
37-
* setters start by set followed by the member name with a capital
40+
* setters start by `set` followed by the member name with a capital
3841

3942
example, projectloader.h:
4043
```C++
4144
class ProjectLoader
4245
{
4346
public:
44-
ProjectLoader();
47+
ProjectLoader();
4548

46-
const QString &path() const;
47-
void setPath(const QString &path);
49+
const QString &globalPath() const;
50+
void setGlobalPath(const QString &globalPath);
4851

4952
protected:
50-
QString _path;
53+
QString _globalPath;
5154
};
5255
```

‎README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Build Status](https://travis-ci.org/UniSwarm/uDevkit-IDE.svg?branch=master)](https://travis-ci.org/UniSwarm/uDevkit-IDE)
55
[![Build status](https://ci.appveyor.com/api/projects/status/7ts34vord4jnooub?svg=true)](https://ci.appveyor.com/project/sebcaux/udevkit-ide)
66

7-
A simple IDE for [RtProg](https://github.com/UniSwarm/rtprog) written in Qt5. This IDE want to be very lightweight and fast to load without a huge project management system.
7+
A simple IDE for [uDevkit](https://github.com/UniSwarm/uDevkit-SDK) written in Qt5. This IDE want to be very lightweight and fast to load without a huge project management system.
88

99
Still in development.
1010

@@ -33,6 +33,15 @@ Qt module used :
3333

3434
## Build
3535

36+
Do not forget to init and update submodule before build :
37+
38+
```
39+
git submodule init
40+
git submodule update
41+
```
42+
43+
And to build :
44+
3645
```
3746
mkdir build
3847
cd build
@@ -46,8 +55,8 @@ Binaries will be placed in `bin/` directory.
4655

4756
For convenience, a pre-built version is available at :
4857

49-
https://ci.appveyor.com/api/projects/sebcaux/udevkit-IDE/artifacts/udk-ide-win64-v0-nodll.zip
58+
https://ci.appveyor.com/api/projects/sebcaux/udevkit-IDE/artifacts/udk-ide-win64-v0.zip
5059

5160
Without Qt DLL (very lite) :
5261

53-
https://ci.appveyor.com/api/projects/sebcaux/udevkit-IDE/artifacts/udk-ide-win64-v0.zip
62+
https://ci.appveyor.com/api/projects/sebcaux/udevkit-IDE/artifacts/udk-ide-win64-v0-nodll.zip

0 commit comments

Comments
 (0)
Please sign in to comment.