Skip to content

Commit f52b330

Browse files
leonhadleonhad
committed
Fixed README files.
1 parent ee5007c commit f52b330

File tree

12 files changed

+440
-257
lines changed

12 files changed

+440
-257
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.mv

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
# How Has This Been Tested?
8+
9+
Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration.
10+
11+
- [ ] Test A
12+
- [ ] Test B
13+
14+
# Checklist:
15+
16+
- [ ] My code follows the style guidelines of this project
17+
- [ ] I have performed a self-review of my own code
18+
- [ ] I have commented my code, particularly in hard-to-understand areas
19+
- [ ] I have made corresponding changes to the documentation
20+
- [ ] My changes generate no new warnings
21+
- [ ] Any dependent changes have been merged and published in downstream modules

‎.gitignore

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
/out
22

3-
/html
4-
5-
/latex
6-
73
*.gcov
84

95
*.gcda
@@ -14,8 +10,6 @@
1410

1511
*.lo
1612

17-
.*
18-
1913
cppunit.xmL
2014

2115
config.h
@@ -24,8 +18,6 @@ config.log
2418

2519
config.status
2620

27-
test/testsuit
28-
2921
*.log
3022

3123
*.trs
@@ -36,8 +28,6 @@ test/testsuit
3628

3729
*.a
3830

39-
bcc/bcc
40-
4131
autom4te.cache
4232

4333
Makefile
@@ -46,10 +36,5 @@ stamp-h1
4636

4737
.deps
4838

49-
/nbproject
50-
5139
/*~
5240

53-
/*.gz
54-
55-
src/testsuit

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# How to contribute
2+
3+
I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
4+
5+
## Submitting changes
6+
7+
Please send a [GitHub Pull Request to msx-bcc](https://github.com/leonhad/msx-bcc/pull/new/master) with a clear list of what you've done. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
8+
9+
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
10+
11+
$ git commit -m "A brief summary of the commit
12+
>
13+
> A paragraph describing what changed and its impact."
14+
15+
## Coding conventions
16+
17+
Start reading our code and you'll get the hang of it. We optimize for readability:
18+
19+
* We indent using four spaces (soft tabs).
20+
* This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
21+
22+
Thanks,
23+
Leonardo Alves da Costa

‎README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MSX Basic Compiler
2+
3+
MSX basic native compiler to modern PC.
4+
5+
# Licensing
6+
7+
This software is released under the GNU Lesser General Public License v3.0 (LGPLv3).
8+
Additionally, Autoconf includes a licensing exception in some of its
9+
source files.
10+
11+
For more licensing information, see
12+
<http://www.gnu.org/licenses/gpl-faq.html>.
13+
14+
-----
15+
Copyright (C) 2019 Leonardo Alves da Costa.
16+
17+
Copying and distribution of this file, with or without modification,
18+
are permitted in any medium without royalty provided the copyright
19+
notice and this notice are preserved. This file is offered as-is,
20+
without warranty of any kind.

‎bcc/analyze.h

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
//
2-
// File: analyze.h
3-
// Author: p922221
4-
//
5-
// Created on 2 de Abril de 2008, 11:35
6-
//
7-
8-
#ifndef _ANALYZE_H
9-
#define _ANALYZE_H
10-
11-
#include "treenode.h"
12-
#include "symtab.h"
13-
14-
namespace bc
15-
{
16-
class Analyze
17-
{
18-
private:
19-
Symtab *symtab;
20-
21-
public:
22-
Analyze();
23-
~Analyze();
24-
vector<SYMTAB *> buildSymtab(TreeNode * syntaxTree);
25-
26-
private:
27-
void traverse(TreeNode * treeNode, void (Analyze::* preProc)(TreeNode *), void (Analyze::* postProc)(TreeNode *));
28-
void insertNode(TreeNode * treeNode);
29-
void nullProc(TreeNode * treeNode);
30-
};
31-
}
32-
33-
#endif /* _ANALYZE_H */
34-
1+
//
2+
// File: analyze.h
3+
// Author: p922221
4+
//
5+
// Created on 2 de Abril de 2008, 11:35
6+
//
7+
8+
#ifndef _ANALYZE_H
9+
#define _ANALYZE_H
10+
11+
#include "treenode.h"
12+
#include "symtab.h"
13+
14+
namespace bc
15+
{
16+
class Analyze
17+
{
18+
private:
19+
Symtab *symtab;
20+
21+
public:
22+
Analyze();
23+
~Analyze();
24+
vector<SYMTAB *> buildSymtab(TreeNode * syntaxTree);
25+
26+
private:
27+
void traverse(TreeNode * treeNode, void (Analyze::* preProc)(TreeNode *), void (Analyze::* postProc)(TreeNode *));
28+
void insertNode(TreeNode * treeNode);
29+
void nullProc(TreeNode * treeNode);
30+
};
31+
}
32+
33+
#endif /* _ANALYZE_H */
34+

‎bcc/attributes.h

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
//
2-
// File: attributes.h
3-
// Author: p922221
4-
//
5-
// Created on 1 de Abril de 2008, 14:21
6-
//
7-
8-
#ifndef _ATTRIBUTES_H
9-
#define _ATTRIBUTES_H
10-
11-
#include "definitions.h"
12-
#include <string>
13-
14-
using namespace definitions;
15-
16-
namespace bc {
17-
class Attributes {
18-
public:
19-
TokenType op;
20-
std::string val;
21-
std::string val2;
22-
std::string name;
23-
24-
Attributes();
25-
~Attributes();
26-
};
27-
}
28-
29-
#endif /* _ATTRIBUTES_H */
30-
1+
//
2+
// File: attributes.h
3+
// Author: p922221
4+
//
5+
// Created on 1 de Abril de 2008, 14:21
6+
//
7+
8+
#ifndef _ATTRIBUTES_H
9+
#define _ATTRIBUTES_H
10+
11+
#include "definitions.h"
12+
#include <string>
13+
14+
using namespace definitions;
15+
16+
namespace bc {
17+
class Attributes {
18+
public:
19+
TokenType op;
20+
std::string val;
21+
std::string val2;
22+
std::string name;
23+
24+
Attributes();
25+
~Attributes();
26+
};
27+
}
28+
29+
#endif /* _ATTRIBUTES_H */
30+

0 commit comments

Comments
 (0)