Skip to content

Commit 57e3def

Browse files
authored
Push 1.5.2 - Fixed broken README :p
1 parent d3ccd24 commit 57e3def

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- PROJECT LOGO -->
2-
<br />
2+
<br/>
33
<p align="center">
44
<a href="https://github.com/AxiomYT/NPF-Rule-Calculator-Python">
55
<img src="logo.svg" alt="Logo" width="80" height="80">
@@ -9,10 +9,8 @@
99

1010
<p align="center">
1111
A useful Astrophotography application to find the ideal exposure time, correcting for planetary shift.
12-
<br />
13-
<!-- <a href="https://github.com/AxiomYT/NPF-Rule-Calculator-Python"><strong>Explore the docs »</strong></a>-->
14-
<br />
15-
<!--<a href="https://github.com/AxiomYT/NPF-Rule-Calculator-Python">View Demo</a>-->
12+
<br/>
13+
<br/>
1614
·
1715
<a href="https://github.com/AxiomYT/NPF-Rule-Calculator-Python/issues">Report Bug</a>
1816
·
@@ -56,8 +54,8 @@
5654
* ~~Make the calculation work~~
5755
* Unit Test
5856
* ~~Pull from config file~~
59-
* Allow selection of pixel_pitch states
60-
* Make 32-bit version work with 64-bit Python
57+
* ~~Allow selection of pixel_pitch states~~
58+
* ~~Incorporate Pathlib~~
6159

6260
<!-- GETTING STARTED -->
6361
## Getting Started
@@ -104,50 +102,48 @@
104102
FOCAL_LENGTH = 300
105103
```
106104
<ul>
107-
<li>APERTURE > Has to be a float in this format 1&ltA&lt22</li>
105+
<li>APERTURE > Has to be a float in this format 1.0&ltA&lt22.0</li>
108106
<li>FOCAL_LENGTH > has to be an int in this format 1&ltF&lt1000</li>
109107
</ul>
110108

111109
```python
112110
PIXEL_PITCH = 6.423611111111111
113-
PIXEL_PITCH = ""
111+
PIXEL_PITCH =
114112

115-
PIXEL_WIDTH = ""
113+
PIXEL_WIDTH =
116114
PIXEL_WIDTH = 3456
117115

118-
PHYSICAL_WIDTH = ""
116+
PHYSICAL_WIDTH =
119117
PHYSICAL_WIDTH = 22.2
120118
```
121119
<ul>
122-
<li>PIXEL_PITCH > Has to be a float in this format 0.1&ltA&lt100</li>
120+
<li>PIXEL_PITCH > Has to be a float in this format 0.1&ltA&lt100.0</li>
123121
<li>PIXEL_WIDTH > has to be an int in this format 1&ltF&lt8192</li>
124-
<li>PHYSICAL_WIDTH > has to be a float in this format 0.1&ltP&lt100</li>
122+
<li>PHYSICAL_WIDTH > has to be a float in this format 0.1&ltP&lt100.0</li>
125123
</ul>
126124

127-
#### ~~Pixel Pitch Differentiation~~
125+
#### Pixel Pitch Differentiation
128126

129-
##### ~~Know Pixel Pitch~~
127+
##### Know Pixel Pitch
130128
```python
131129
PIXEL_PITCH = 6.423611111111111
132130

133-
PIXEL_WIDTH = ""
134-
PHYSICAL_WIDTH = ""
131+
PIXEL_WIDTH =
132+
PHYSICAL_WIDTH =
135133
```
136134

137-
##### ~~Don't Know Pixel Pitch~~
135+
##### Don't Know Pixel Pitch
138136
```python
139-
PIXEL_PITCH = ""
137+
PIXEL_PITCH =
140138

141139
PIXEL_WIDTH = 3456
142140
PHYSICAL_WIDTH = 22.2
143141
```
144-
<h3>Not Currently implemented</h3>
142+
* Essentially - If you enter a manual value for pixel pitch, the programme will use this - and ignore the values for Pixel and Physical Width.
145143

146144
<!-- CONTRIBUTING -->
147145
## Contributing
148146

149-
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
150-
151147
1. Fork the Project
152148
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
153149
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
@@ -159,11 +155,9 @@ Contributions are what make the open source community such an amazing place to b
159155

160156
Distributed under the MIT License. See `LICENSE` for more information.
161157

162-
163-
164158
<!-- CONTACT -->
165159
## Contact
166160

167161
Axiom - [@MM7OWO](https://twitter.com/MM7OWO)
168162

169-
Project Link: [https://github.com/AxiomYT/NPF-Rule-Calculator-Python](https://github.com/AxiomYT/NPF-Rule-Calculator-Python)
163+
Project Link: [https://github.com/AxiomYT/NPF-Rule-Calculator-Python](https://github.com/AxiomYT/NPF-Rule-Calculator-Python)

0 commit comments

Comments
 (0)